Wells, Well

The <Wells> element of the XML configuration contains a list of <Well>s associated with each header. Each well is associated with a facility tag, a position number, enabled value or enabled UDC, and a sequence number or sequence UDC. Only enabled wells will be tested. Two attributes, enabled and enabledUdc, are used to determine if the well is active and should be tested. Two attributes, sequence and sequenceUdc, are used to determine the testing sequence of the wells.

To learn about how these elements relate to other elements in a well test configuration XML structure, see Well Test Hierarchy.

Example

<Headers>

<Header tag="MYSITE.UIS::BUTCHER_TESTSEP" enabled="True" template="MbSim">

<Wells>

<Well tag="MYSITE.UIS::AMANDA_WL" position="1" sequence="1" enabled="True" enabledUdc="ENABLED"/>

<Well tag="MYSITE.UIS::ESSEN_WL" position="2" sequence="2" enabled="True" enabledUdc="ENABLED"/>

<Well tag="MYSITE.UIS::PELICAN_WL" position="3" sequence="3" enabled="True" enabledUdc="ENABLED"/>

<Well tag="MYSITE.UIS::VIRGINIA_WL" position="4" enabled="True" enabledUdc="ENABLED" sequenceUdc="SEQ" />

</Wells>

</Header>

</Headers>

Wells

The <Wells> element has one type of child element, <Well>, and has no attributes.

Well

Well Properties

The <Well> element has the following properties:

Property Description

Case Sensitive

Yes

Required

Yes

Number of Instances Allowed

Unlimited

Parent Element

<Wells>

Child Elements

None

Attributes

enabled

enabledUdc

position

sequence

sequenceUdc

tag

Well Attributes

Each <Well> element has the following attributes:

Attribute Required Description

enabled

Yes

Specifies whether the well can be tested. While it is possible for the header queue to contain wells that are disabled, only enabled wells will be tested. When a well is read from the top of the header queue, prior to testing, the enabled attribute will be read.

  • If the well is enabled (True), the associated well command and actions will be processed
  • If the well is not enabled (False), the well will not be tested and the next well in the queue will be evaluated

Note: Make sure you read the definition for the enabledUdc attribute for further usage notes on the enabled attribute.

Options include True or False.

enabledUdc

No

The Enabled UDC property (enabledUdc) allows the configuration of the Enabled (enabled) property by point. The defined UDC will be combined with the facility tag to formulate a point. The Enabled UDC Property /enabledUdc attribute takes precedence over the Enabled (enabled). Click the browse button to open the Select UDC dialog box and select an appropriate UDC.

  • If that point exists and has a valid value (either True or False), then that value is used to determine the enabled status.
  • If the point doesn’t exist or the value is invalid, then the enabled attribute value will be used. If in this case, the enabled attribute is not configured, and it will be assumed that the well is not enabled.

Note: This attribute allows manipulation of a well's enabled/disabled status external to the Canvas Well Test Status screen, and the CygNet Well Test Module.

position

Yes

Specifies the position number for the well. This must line up with one of the positions in the associated header template. Values include 1, 2, 3, …, n.

sequence

Yes

Specifies the sequence number for the well. Determines the order in which the wells are tested in the queue. The Wells queue will be updated using the current value of Sequence or Sequence UDC before starting the next test, so that the queue can change dynamically each time a new test for any position on the Header is started.

When using the Continuous or Schedule queue actions, the well test will follow the sequence order. The Well Test service reads the queue, completes the pending queue and then re-reads the configuration, pulling in the wells in the order of the sequence. Values include 1, 2, 3, …, n.

The Well.GetSequence() method in the CygNet.API.WellTest returns the sequence order.

Note: Read the definition for the sequenceUdc attribute for further usage notes on this attribute.

sequenceUDC

No

The Sequence UDC property / sequenceUdc attribute allows the adjustment of a well's Sequence (sequence) assignment by UDC to manage the order of well in the test on the fly. The Wells queue will be updated using the current value of Sequence or Sequence UDC before starting the next test, so that the queue can change dynamically each time a new test for any position on the Header is started.

Specify a Sequence number in the well test configuration or a Sequence UDC to take a value from a point value. When using the Continuous or Schedule queue actions, the test will follow the sequence order. The UDC will be combined with the facility tag to formulate a point.

Click the browse button to open the Select UDC dialog box and select the appropriate UDC, "SEQ".

  • If that point exists and has a valid value, then that value is used to determine the test sequence.
  • If the point doesn’t exist or the value is invalid, then the sequence attribute value will be used. If in this case, the sequence attribute is not configured, and it will be assumed that the well is not sequenced.
  • If both Sequence and Sequence UDC have assigned values, Sequence UDC takes precedence over Sequence.
  • The Well.GetSequence() method in the CygNet.API.WellTest returns the sequence order.

Note: This attribute allows manipulation of a well's sequence external to the Canvas Well Test Status screen, and the CygNet Well Test Module.

tag

Yes

Specifies the fully qualified facility tag of the well in the format: site.service::facility_id. E.g., MYSITE.UIS::AMANDA_WL.

Back to top